Upload coverage report from main directly
#125
Conversation
There was a problem hiding this comment.
Ok, I have no clue whats going on here exactly but it doesnt look like it will break anything...
On that note, why are we running the build-docs workflow on PRs and pushes to main (or at all, since we also let RTD build the docs for every PR)? Our own workflow is slightly faster than RTD, but the pages are not rendered as nicely.
Also no clue, the git blame points to me because I moved the workflow file at some point but i think originally this was added by @danielhuppmann or @phackstock and might also be connected to the old self hosted docs setup?
|
Thanks for the context! I think I'll disable the workflow, then. No need to duplicate building the docs (or else, we could quickly add it back in) and RTD's rendering seems more practical to me. |
While thinking about how to work with Codecov and the
squash & mergeworkflow, I now believe the following workflow should work:override_branch: mainso that the commit also seems to belong tomainSubsequent PRs should then be able to find the reports (but see here for a caveat) and compare to them successfully.
So the first commit on this PR sets up the double uploading. Unfortunately, while thinking about this a bit more, I understood that this workflow won't work for PRs with revisions, so to speak: when the tests run once on a PR and upload its coverage, that coverage would be assumed to be valid for
main, too. If you then need to improve your code later one and run the checks again, it would be run against the previously last commit of this PR, essentially rendering thepatchchecks (usually indicating coverage changes by this PR) meaningless.Thus, the second commit simply enables the whole workflow on PRs as well as pushes to
main, which wastes some computational resources, but seems to be the easiest way on our side.I'll leave a note, however, to watch the issue linked above and revise our workflow once a better one becomes available.
On that note, why are we running the
build-docsworkflow on PRs and pushes tomain(or at all, since we also let RTD build the docs for every PR)? Our own workflow is slightly faster than RTD, but the pages are not rendered as nicely.